package com.cx.base.autoDoc.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.apache.commons.lang.ObjectUtils.Null;

/**
 * 自动生成接口文档--请求方法，必须要添加此注解
 * 
 * @author cenxi
 * @date 2015-11-11
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AutoDocMethod {
	
	/**
	 * 方法中文简称
	 */
	public String name();
	
	/**
	 * 返回对象
	 * */
	public Class<?> resClazz() default Null.class;
	
	/**
	 * 分页类
	 * */
	public Class pageClazz() default Null.class;
	
	/**
	 * 返回对象集合类型 list，map
	 * */
	public String resSet() default "";
	
	/**
	 * 描述
	 * */
	public String desc();
}
